Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Convert run-over-aoi ipynb to md #122

Merged
merged 2 commits into from
Jan 16, 2024
Merged

Conversation

yellowcap
Copy link
Member

The ipynb will not run in build because its too long to run. So this needs to be frozen into md for the docs.

This also applies to the other ipynb in the docs most likely.

@yellowcap yellowcap force-pushed the convert-run-region-ipynb-to-md branch 2 times, most recently from 5b94c84 to 35e0412 Compare January 15, 2024 16:45
@yellowcap yellowcap force-pushed the convert-run-region-ipynb-to-md branch from 35e0412 to 9fdf557 Compare January 15, 2024 16:47
Copy link
Contributor

@weiji14 weiji14 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @yellowcap, much easier to review the markdown! Just some typos on the mkdir command, otherwise ok.

Btw, we can also set execute_notebooks: 'cache' here:
https://github.com/Clay-foundation/model/blob/a4377ccd674d5770a000db53bc7334805995e8f4/docs/_config.yml#L8C1-L11C27

This will only run the notebooks if there are no outputs in the cells. See https://jupyterbook.org/en/stable/content/execute.html for more details, there are other options such as excluding specific files from being run.

docs/run_region.md Outdated Show resolved Hide resolved
weiji14 added a commit that referenced this pull request Jan 16, 2024
Will be handled in #122
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
@yellowcap yellowcap merged commit 8309c50 into main Jan 16, 2024
4 checks passed
@yellowcap yellowcap deleted the convert-run-region-ipynb-to-md branch January 16, 2024 09:04
yellowcap added a commit that referenced this pull request Jan 16, 2024
* Make the clay model work on lightning cli

* Update Mean & std for larger chunk of data

* Update model & trainer to work on multi gpu setup

* Fix logging images to wandb

* Add specification docs

* Add trainer details

* Add streamlit UI to test the embeddings (#108)

UI supports vector search & arithmetic for embeddings generated from CLAY.

---------

Co-authored-by: SRM <soumya@developmentseed.org>

* Use rasterio.plot to show images & filter by year, tile & idx

* Fix half:0 error by not explicitly setting float16 to cube[pixels]

* Add documentation to create the pixel reconstruction from the model

* Add documention explaining location embeddings

* Add shuffle as an argument to CLAY

* Add documentation to showcase interpolation between images in embedding space

* Adapt data pipeline to accept custom date range and local path for storing tiles

* Add example script to run clay over custom AOI.

* add sections to TOC

* basic use from root README

* Install from root REAMDE

* how to build/preview docs

* more narrative on release notes

* more narrative on intro

* rename intro to index, better SEO

* reorder for clarity

* fixed links

* fixed links

* renamed file for clarity

* added links and consistent title

* typo

* Closes #64, as much as I can imagine.

* results explanation

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* shorter line

* Making ruff happy

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Making ruff happy

* Moved shuffle to an optional keyword. CHECK

* Recovered from 0145e55

* Clearing outputs for notebooks. Should not merge into main been PR is squashed.

* tested to run

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* tested to run

* Update docs/_toc.yml

Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>

* assume root folder

Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>

* Update src/model_clay.py

Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>

* Update src/model_clay.py

Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>

* Update src/model_clay.py

Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>

* Update docs/README

Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>

* Update docs/installation.md

Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>

* Let pre-commit enforce 512KB file size limit in entire repo

Make sure that large files don't get commited to git. Xref https://github.com/pre-commit/pre-commit-hooks/tree/v4.5.0#check-added-large-files

* Remove extra args.update lines

* Set execute_notebooks to cache

Don't force running all notebooks on the docs build, only run those that don't have output cells already.

* Remove PNG files in docs/assets, replace with web version

Hosting the PNG images directly via GitHub's UI, instead of in the git repo.

* Only build files in toc and rename docs/README to docs/README.md

Don't build files that aren't in the Table of Contents (https://jupyterbook.org/en/stable/structure/configure.html#disable-building-files-that-arent-in-the-table-of-contents). Can then rename README to README.md without raising a warning like `WARNING: document isn't included in any toctree`.

* Use huggingface ckpt, fix header, and rm sample.gif in interpolation nb

Some minor changes to the clay-v0-interpolation.ipynb file, and remove the large sample.gif file. Also gitignoring .gif and .png files.

* Fix some link typos and edit wording on main index page

* Remove run_region notebook

Will be handled in #122

* Fix typos in model specification

Should be 10 bands of Sentinel-2, not 13.

* Rename tutorial notebooks

* Exclude tutorial notebooks from execution during build.

* Make tutorial title consistent

---------

Co-authored-by: SRM <soumya@developmentseed.org>
Co-authored-by: Soumya Ranjan Mohanty <vnn.soumya2@gmail.com>
Co-authored-by: Daniel Wiesmann <daniel@wiesmann.pt>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
Co-authored-by: Daniel Wiesmann <yellowcap@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants